<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2011 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> * <a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except<a name="line.4"></a>
<span class="sourceLineNo">005</span> * in compliance with the License. You may obtain a copy of the License at<a name="line.5"></a>
<span class="sourceLineNo">006</span> * <a name="line.6"></a>
<span class="sourceLineNo">007</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.7"></a>
<span class="sourceLineNo">008</span> * <a name="line.8"></a>
<span class="sourceLineNo">009</span> * Unless required by applicable law or agreed to in writing, software distributed under the<a name="line.9"></a>
<span class="sourceLineNo">010</span> * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either<a name="line.10"></a>
<span class="sourceLineNo">011</span> * express or implied. See the License for the specific language governing permissions and<a name="line.11"></a>
<span class="sourceLineNo">012</span> * limitations under the License.<a name="line.12"></a>
<span class="sourceLineNo">013</span> */<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>package com.google.common.primitives;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>import static com.google.common.base.Preconditions.checkArgument;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import static com.google.common.base.Preconditions.checkNotNull;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import com.google.common.annotations.Beta;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import com.google.common.annotations.GwtCompatible;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.Serializable;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.math.BigInteger;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import javax.annotation.Nullable;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * A wrapper class for unsigned {@code long} values, supporting arithmetic operations.<a name="line.29"></a>
<span class="sourceLineNo">030</span> * <a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;p&gt;In some cases, when speed is more important than code readability, it may be faster simply to<a name="line.31"></a>
<span class="sourceLineNo">032</span> * treat primitive {@code long} values as unsigned, using the methods from {@link UnsignedLongs}.<a name="line.32"></a>
<span class="sourceLineNo">033</span> * <a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p&gt;See the Guava User Guide article on &lt;a href=<a name="line.34"></a>
<span class="sourceLineNo">035</span> * "http://code.google.com/p/guava-libraries/wiki/PrimitivesExplained#Unsigned_support"&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * unsigned primitive utilities&lt;/a&gt;.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * <a name="line.37"></a>
<span class="sourceLineNo">038</span> * @author Louis Wasserman<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @author Colin Evans<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @since 11.0<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span>@Beta<a name="line.42"></a>
<span class="sourceLineNo">043</span>@GwtCompatible(serializable = true)<a name="line.43"></a>
<span class="sourceLineNo">044</span>public final class UnsignedLong extends Number implements Comparable&lt;UnsignedLong&gt;, Serializable {<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span>  private static final long UNSIGNED_MASK = 0x7fffffffffffffffL;<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span>  public static final UnsignedLong ZERO = new UnsignedLong(0);<a name="line.48"></a>
<span class="sourceLineNo">049</span>  public static final UnsignedLong ONE = new UnsignedLong(1);<a name="line.49"></a>
<span class="sourceLineNo">050</span>  public static final UnsignedLong MAX_VALUE = new UnsignedLong(-1L);<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span>  private final long value;<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>  private UnsignedLong(long value) {<a name="line.54"></a>
<span class="sourceLineNo">055</span>    this.value = value;<a name="line.55"></a>
<span class="sourceLineNo">056</span>  }<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span>  /**<a name="line.58"></a>
<span class="sourceLineNo">059</span>   * Returns an {@code UnsignedLong} that, when treated as signed, is equal to {@code value}. The<a name="line.59"></a>
<span class="sourceLineNo">060</span>   * inverse operation is {@link #longValue()}.<a name="line.60"></a>
<span class="sourceLineNo">061</span>   * <a name="line.61"></a>
<span class="sourceLineNo">062</span>   * &lt;p&gt;Put another way, if {@code value} is negative, the returned result will be equal to<a name="line.62"></a>
<span class="sourceLineNo">063</span>   * {@code 2^64 + value}; otherwise, the returned result will be equal to {@code value}.<a name="line.63"></a>
<span class="sourceLineNo">064</span>   */<a name="line.64"></a>
<span class="sourceLineNo">065</span>  public static UnsignedLong asUnsigned(long value) {<a name="line.65"></a>
<span class="sourceLineNo">066</span>    return new UnsignedLong(value);<a name="line.66"></a>
<span class="sourceLineNo">067</span>  }<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span>  /**<a name="line.69"></a>
<span class="sourceLineNo">070</span>   * Returns a {@code UnsignedLong} representing the same value as the specified {@code BigInteger}<a name="line.70"></a>
<span class="sourceLineNo">071</span>   * . This is the inverse operation of {@link #bigIntegerValue()}.<a name="line.71"></a>
<span class="sourceLineNo">072</span>   * <a name="line.72"></a>
<span class="sourceLineNo">073</span>   * @throws IllegalArgumentException if {@code value} is negative or {@code value &gt;= 2^64}<a name="line.73"></a>
<span class="sourceLineNo">074</span>   */<a name="line.74"></a>
<span class="sourceLineNo">075</span>  public static UnsignedLong valueOf(BigInteger value) {<a name="line.75"></a>
<span class="sourceLineNo">076</span>    checkNotNull(value);<a name="line.76"></a>
<span class="sourceLineNo">077</span>    checkArgument(value.signum() &gt;= 0 &amp;&amp; value.bitLength() &lt;= Long.SIZE,<a name="line.77"></a>
<span class="sourceLineNo">078</span>        "value (%s) is outside the range for an unsigned long value", value);<a name="line.78"></a>
<span class="sourceLineNo">079</span>    return asUnsigned(value.longValue());<a name="line.79"></a>
<span class="sourceLineNo">080</span>  }<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span>  /**<a name="line.82"></a>
<span class="sourceLineNo">083</span>   * Returns an {@code UnsignedLong} holding the value of the specified {@code String}, parsed as<a name="line.83"></a>
<span class="sourceLineNo">084</span>   * an unsigned {@code long} value.<a name="line.84"></a>
<span class="sourceLineNo">085</span>   * <a name="line.85"></a>
<span class="sourceLineNo">086</span>   * @throws NumberFormatException if the string does not contain a parsable unsigned {@code long}<a name="line.86"></a>
<span class="sourceLineNo">087</span>   *         value<a name="line.87"></a>
<span class="sourceLineNo">088</span>   */<a name="line.88"></a>
<span class="sourceLineNo">089</span>  public static UnsignedLong valueOf(String string) {<a name="line.89"></a>
<span class="sourceLineNo">090</span>    return valueOf(string, 10);<a name="line.90"></a>
<span class="sourceLineNo">091</span>  }<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span>  /**<a name="line.93"></a>
<span class="sourceLineNo">094</span>   * Returns an {@code UnsignedLong} holding the value of the specified {@code String}, parsed as<a name="line.94"></a>
<span class="sourceLineNo">095</span>   * an unsigned {@code long} value in the specified radix.<a name="line.95"></a>
<span class="sourceLineNo">096</span>   * <a name="line.96"></a>
<span class="sourceLineNo">097</span>   * @throws NumberFormatException if the string does not contain a parsable unsigned {@code long}<a name="line.97"></a>
<span class="sourceLineNo">098</span>   *         value, or {@code radix} is not between {@link Character#MIN_RADIX} and<a name="line.98"></a>
<span class="sourceLineNo">099</span>   *         {@link Character#MAX_RADIX}<a name="line.99"></a>
<span class="sourceLineNo">100</span>   */<a name="line.100"></a>
<span class="sourceLineNo">101</span>  public static UnsignedLong valueOf(String string, int radix) {<a name="line.101"></a>
<span class="sourceLineNo">102</span>    return asUnsigned(UnsignedLongs.parseUnsignedLong(string, radix));<a name="line.102"></a>
<span class="sourceLineNo">103</span>  }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span>  /**<a name="line.105"></a>
<span class="sourceLineNo">106</span>   * Returns the result of adding this and {@code val}. If the result would have more than 64 bits,<a name="line.106"></a>
<span class="sourceLineNo">107</span>   * returns the low 64 bits of the result.<a name="line.107"></a>
<span class="sourceLineNo">108</span>   */<a name="line.108"></a>
<span class="sourceLineNo">109</span>  public UnsignedLong add(UnsignedLong val) {<a name="line.109"></a>
<span class="sourceLineNo">110</span>    checkNotNull(val);<a name="line.110"></a>
<span class="sourceLineNo">111</span>    return asUnsigned(this.value + val.value);<a name="line.111"></a>
<span class="sourceLineNo">112</span>  }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span>  /**<a name="line.114"></a>
<span class="sourceLineNo">115</span>   * Returns the result of subtracting this and {@code val}. If the result would be negative,<a name="line.115"></a>
<span class="sourceLineNo">116</span>   * returns the low 64 bits of the result.<a name="line.116"></a>
<span class="sourceLineNo">117</span>   */<a name="line.117"></a>
<span class="sourceLineNo">118</span>  public UnsignedLong subtract(UnsignedLong val) {<a name="line.118"></a>
<span class="sourceLineNo">119</span>    checkNotNull(val);<a name="line.119"></a>
<span class="sourceLineNo">120</span>    return asUnsigned(this.value - val.value);<a name="line.120"></a>
<span class="sourceLineNo">121</span>  }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span>  /**<a name="line.123"></a>
<span class="sourceLineNo">124</span>   * Returns the result of multiplying this and {@code val}. If the result would have more than 64<a name="line.124"></a>
<span class="sourceLineNo">125</span>   * bits, returns the low 64 bits of the result.<a name="line.125"></a>
<span class="sourceLineNo">126</span>   */<a name="line.126"></a>
<span class="sourceLineNo">127</span>  public UnsignedLong multiply(UnsignedLong val) {<a name="line.127"></a>
<span class="sourceLineNo">128</span>    checkNotNull(val);<a name="line.128"></a>
<span class="sourceLineNo">129</span>    return asUnsigned(value * val.value);<a name="line.129"></a>
<span class="sourceLineNo">130</span>  }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span>  /**<a name="line.132"></a>
<span class="sourceLineNo">133</span>   * Returns the result of dividing this by {@code val}.<a name="line.133"></a>
<span class="sourceLineNo">134</span>   */<a name="line.134"></a>
<span class="sourceLineNo">135</span>  public UnsignedLong divide(UnsignedLong val) {<a name="line.135"></a>
<span class="sourceLineNo">136</span>    checkNotNull(val);<a name="line.136"></a>
<span class="sourceLineNo">137</span>    return asUnsigned(UnsignedLongs.divide(value, val.value));<a name="line.137"></a>
<span class="sourceLineNo">138</span>  }<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span>  /**<a name="line.140"></a>
<span class="sourceLineNo">141</span>   * Returns the remainder of dividing this by {@code val}.<a name="line.141"></a>
<span class="sourceLineNo">142</span>   */<a name="line.142"></a>
<span class="sourceLineNo">143</span>  public UnsignedLong remainder(UnsignedLong val) {<a name="line.143"></a>
<span class="sourceLineNo">144</span>    checkNotNull(val);<a name="line.144"></a>
<span class="sourceLineNo">145</span>    return asUnsigned(UnsignedLongs.remainder(value, val.value));<a name="line.145"></a>
<span class="sourceLineNo">146</span>  }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span>  /**<a name="line.148"></a>
<span class="sourceLineNo">149</span>   * Returns the value of this {@code UnsignedLong} as an {@code int}.<a name="line.149"></a>
<span class="sourceLineNo">150</span>   */<a name="line.150"></a>
<span class="sourceLineNo">151</span>  @Override<a name="line.151"></a>
<span class="sourceLineNo">152</span>  public int intValue() {<a name="line.152"></a>
<span class="sourceLineNo">153</span>    return (int) value;<a name="line.153"></a>
<span class="sourceLineNo">154</span>  }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span>  /**<a name="line.156"></a>
<span class="sourceLineNo">157</span>   * Returns the value of this {@code UnsignedLong} as a {@code long}. This is an inverse operation<a name="line.157"></a>
<span class="sourceLineNo">158</span>   * to {@link #asUnsigned}.<a name="line.158"></a>
<span class="sourceLineNo">159</span>   * <a name="line.159"></a>
<span class="sourceLineNo">160</span>   * &lt;p&gt;Note that if this {@code UnsignedLong} holds a value {@code &gt;= 2^63}, the returned value<a name="line.160"></a>
<span class="sourceLineNo">161</span>   * will be equal to {@code this - 2^64}.<a name="line.161"></a>
<span class="sourceLineNo">162</span>   */<a name="line.162"></a>
<span class="sourceLineNo">163</span>  @Override<a name="line.163"></a>
<span class="sourceLineNo">164</span>  public long longValue() {<a name="line.164"></a>
<span class="sourceLineNo">165</span>    return value;<a name="line.165"></a>
<span class="sourceLineNo">166</span>  }<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span>  /**<a name="line.168"></a>
<span class="sourceLineNo">169</span>   * Returns the value of this {@code UnsignedLong} as a {@code float}, analogous to a widening<a name="line.169"></a>
<span class="sourceLineNo">170</span>   * primitive conversion from {@code long} to {@code float}, and correctly rounded.<a name="line.170"></a>
<span class="sourceLineNo">171</span>   */<a name="line.171"></a>
<span class="sourceLineNo">172</span>  @Override<a name="line.172"></a>
<span class="sourceLineNo">173</span>  public float floatValue() {<a name="line.173"></a>
<span class="sourceLineNo">174</span>    @SuppressWarnings("cast")<a name="line.174"></a>
<span class="sourceLineNo">175</span>    float fValue = (float) (value &amp; UNSIGNED_MASK);<a name="line.175"></a>
<span class="sourceLineNo">176</span>    if (value &lt; 0) {<a name="line.176"></a>
<span class="sourceLineNo">177</span>      fValue += 0x1.0p63f;<a name="line.177"></a>
<span class="sourceLineNo">178</span>    }<a name="line.178"></a>
<span class="sourceLineNo">179</span>    return fValue;<a name="line.179"></a>
<span class="sourceLineNo">180</span>  }<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span>  /**<a name="line.182"></a>
<span class="sourceLineNo">183</span>   * Returns the value of this {@code UnsignedLong} as a {@code double}, analogous to a widening<a name="line.183"></a>
<span class="sourceLineNo">184</span>   * primitive conversion from {@code long} to {@code double}, and correctly rounded.<a name="line.184"></a>
<span class="sourceLineNo">185</span>   */<a name="line.185"></a>
<span class="sourceLineNo">186</span>  @Override<a name="line.186"></a>
<span class="sourceLineNo">187</span>  public double doubleValue() {<a name="line.187"></a>
<span class="sourceLineNo">188</span>    @SuppressWarnings("cast")<a name="line.188"></a>
<span class="sourceLineNo">189</span>    double dValue = (double) (value &amp; UNSIGNED_MASK);<a name="line.189"></a>
<span class="sourceLineNo">190</span>    if (value &lt; 0) {<a name="line.190"></a>
<span class="sourceLineNo">191</span>      dValue += 0x1.0p63;<a name="line.191"></a>
<span class="sourceLineNo">192</span>    }<a name="line.192"></a>
<span class="sourceLineNo">193</span>    return dValue;<a name="line.193"></a>
<span class="sourceLineNo">194</span>  }<a name="line.194"></a>
<span class="sourceLineNo">195</span><a name="line.195"></a>
<span class="sourceLineNo">196</span>  /**<a name="line.196"></a>
<span class="sourceLineNo">197</span>   * Returns the value of this {@code UnsignedLong} as a {@link BigInteger}.<a name="line.197"></a>
<span class="sourceLineNo">198</span>   */<a name="line.198"></a>
<span class="sourceLineNo">199</span>  public BigInteger bigIntegerValue() {<a name="line.199"></a>
<span class="sourceLineNo">200</span>    BigInteger bigInt = BigInteger.valueOf(value &amp; UNSIGNED_MASK);<a name="line.200"></a>
<span class="sourceLineNo">201</span>    if (value &lt; 0) {<a name="line.201"></a>
<span class="sourceLineNo">202</span>      bigInt = bigInt.setBit(Long.SIZE - 1);<a name="line.202"></a>
<span class="sourceLineNo">203</span>    }<a name="line.203"></a>
<span class="sourceLineNo">204</span>    return bigInt;<a name="line.204"></a>
<span class="sourceLineNo">205</span>  }<a name="line.205"></a>
<span class="sourceLineNo">206</span><a name="line.206"></a>
<span class="sourceLineNo">207</span>  @Override<a name="line.207"></a>
<span class="sourceLineNo">208</span>  public int compareTo(UnsignedLong o) {<a name="line.208"></a>
<span class="sourceLineNo">209</span>    checkNotNull(o);<a name="line.209"></a>
<span class="sourceLineNo">210</span>    return UnsignedLongs.compare(value, o.value);<a name="line.210"></a>
<span class="sourceLineNo">211</span>  }<a name="line.211"></a>
<span class="sourceLineNo">212</span><a name="line.212"></a>
<span class="sourceLineNo">213</span>  @Override<a name="line.213"></a>
<span class="sourceLineNo">214</span>  public int hashCode() {<a name="line.214"></a>
<span class="sourceLineNo">215</span>    return Longs.hashCode(value);<a name="line.215"></a>
<span class="sourceLineNo">216</span>  }<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span>  @Override<a name="line.218"></a>
<span class="sourceLineNo">219</span>  public boolean equals(@Nullable Object obj) {<a name="line.219"></a>
<span class="sourceLineNo">220</span>    if (obj instanceof UnsignedLong) {<a name="line.220"></a>
<span class="sourceLineNo">221</span>      UnsignedLong other = (UnsignedLong) obj;<a name="line.221"></a>
<span class="sourceLineNo">222</span>      return value == other.value;<a name="line.222"></a>
<span class="sourceLineNo">223</span>    }<a name="line.223"></a>
<span class="sourceLineNo">224</span>    return false;<a name="line.224"></a>
<span class="sourceLineNo">225</span>  }<a name="line.225"></a>
<span class="sourceLineNo">226</span><a name="line.226"></a>
<span class="sourceLineNo">227</span>  /**<a name="line.227"></a>
<span class="sourceLineNo">228</span>   * Returns a string representation of the {@code UnsignedLong} value, in base 10.<a name="line.228"></a>
<span class="sourceLineNo">229</span>   */<a name="line.229"></a>
<span class="sourceLineNo">230</span>  @Override<a name="line.230"></a>
<span class="sourceLineNo">231</span>  public String toString() {<a name="line.231"></a>
<span class="sourceLineNo">232</span>    return UnsignedLongs.toString(value);<a name="line.232"></a>
<span class="sourceLineNo">233</span>  }<a name="line.233"></a>
<span class="sourceLineNo">234</span><a name="line.234"></a>
<span class="sourceLineNo">235</span>  /**<a name="line.235"></a>
<span class="sourceLineNo">236</span>   * Returns a string representation of the {@code UnsignedLong} value, in base {@code radix}. If<a name="line.236"></a>
<span class="sourceLineNo">237</span>   * {@code radix &lt; Character.MIN_RADIX} or {@code radix &gt; Character.MAX_RADIX}, the radix<a name="line.237"></a>
<span class="sourceLineNo">238</span>   * {@code 10} is used.<a name="line.238"></a>
<span class="sourceLineNo">239</span>   */<a name="line.239"></a>
<span class="sourceLineNo">240</span>  public String toString(int radix) {<a name="line.240"></a>
<span class="sourceLineNo">241</span>    return UnsignedLongs.toString(value, radix);<a name="line.241"></a>
<span class="sourceLineNo">242</span>  }<a name="line.242"></a>
<span class="sourceLineNo">243</span>}<a name="line.243"></a>




























































</pre>
</div>
</body>
</html>
